home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / video / vlcreatebuffer.z / vlcreatebuffer
Encoding:
Text File  |  2002-10-03  |  3.7 KB  |  67 lines
  1.  
  2.  
  3.  
  4. VVVVLLLLCCCCRRRREEEEAAAATTTTEEEEBBBBUUUUFFFFFFFFEEEERRRR((((3333ddddmmmm))))                                        VVVVLLLLCCCCRRRREEEEAAAATTTTEEEEBBBBUUUUFFFFFFFFEEEERRRR((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      vlCreateBuffer, vlDestroyBuffer - IRIS VL buffer create and destroy
  10.      routines
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////vvvvllll....hhhh>>>>
  14.  
  15.      VVVVLLLLBBBBuuuuffffffffeeeerrrr vvvvllllCCCCrrrreeeeaaaatttteeeeBBBBuuuuffffffffeeeerrrr((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLPPPPaaaatttthhhh ppppaaaatttthhhh,,,, VVVVLLLLNNNNooooddddeeee nnnnooooddddeeee,,,, iiiinnnntttt nnnnffffrrrraaaammmmeeeessss))));;;;
  16.      iiiinnnntttt vvvvllllDDDDeeeessssttttrrrrooooyyyyBBBBuuuuffffffffeeeerrrr((((VVVVLLLLSSSSeeeerrrrvvvveeeerrrr ssssvvvvrrrr,,,, VVVVLLLLBBBBuuuuffffffffeeeerrrr bbbbuuuuffffffffeeeerrrr))));;;;
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      vvvvllllCCCCrrrreeeeaaaatttteeeeBBBBuuuuffffffffeeeerrrr creates and returns a handle to a buffer which can then be
  20.      registered with a path and used to send or receive video data.
  21.  
  22.      A _V_L_B_u_f_f_e_r consists of a list of frame-sized regions of memory each with
  23.      an associated header block. Buffers are needed for transferring data to
  24.      or from memory nodes. To receive a frame, the reader calls one of
  25.      vvvvllllGGGGeeeettttNNNNeeeexxxxttttVVVVaaaalllliiiidddd or vvvvllllGGGGeeeettttLLLLaaaatttteeeessssttttVVVVaaaalllliiiidddd , and to free that frame calls
  26.      vvvvllllPPPPuuuuttttFFFFrrrreeeeeeee.  To send a frame, the writer calls vvvvllllGGGGeeeettttNNNNeeeexxxxttttFFFFrrrreeeeeeee, copies the
  27.      data to be sent into the acquired buffer, and then vvvvllllPPPPuuuuttttVVVVaaaalllliiiidddd to send
  28.      that frame.
  29.  
  30.      Various controls affect buffer size. Setting controls which affect frame
  31.      size should be done prior to calling vvvvllllCCCCrrrreeeeaaaatttteeeeBBBBuuuuffffffffeeeerrrr.... These controls
  32.      include VL_CAP_TYPE, VL_PACKING, VL_SIZE, VL_ZOOM, VL_OFFSET and
  33.      VL_TIMING.
  34.  
  35.      vvvvllllDDDDeeeessssttttrrrrooooyyyyBBBBuuuuffffffffeeeerrrr destroys a buffer and frees any associated resources.
  36.  
  37. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  38.      vlCreateBuffer returns a buffer handle upon successful completion.
  39.      Otherwise, NULL is returned and _v_l_E_r_r_n_o is set to indicate the error.
  40.  
  41.      vlDestroyBuffer returns 0 if the server handle is valid, otherwise it
  42.      returns -1 and sets vlErrno to VLBadServer.
  43.  
  44.  
  45. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  46.      vlCreatePath(3dm), vlBeginTransfer(3dm), vlRegisterBuffer(3dm),
  47.      vlGetNextValid(3dm), vlSetControl(3dm)
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.